home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3 / Vk / VkNLS.z / VkNLS
Encoding:
Text File  |  1998-10-20  |  10.7 KB  |  265 lines
  1.  
  2.  
  3.  
  4. VVVVkkkkNNNNLLLLSSSS((((3333xxxx))))                                                            VVVVkkkkNNNNLLLLSSSS((((3333xxxx))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      VkNLS - Network Licensing support
  10.  
  11.  
  12.  
  13.  
  14. WWWWAAAARRRRNNNNIIIINNNNGGGG
  15.      TTTTHHHHIIIISSSS CCCCLLLLAAAASSSSSSSS IIIISSSS OOOOBBBBSSSSOOOOLLLLEEEETTTTEEEE....  IIIITTTT IIIISSSS RRRREEEETTTTAAAAIIIINNNNEEEEDDDD IIIINNNN VVVVIIIIEEEEWWWWKKKKIIIITTTT OOOONNNNLLLLYYYY FFFFOOOORRRR CCCCOOOOMMMMPPPPAAAATTTTIIIIBBBBIIIILLLLIIIITTTTYYYY
  16.      PPPPUUUURRRRPPPPOOOOSSSSEEEESSSS....  PPPPLLLLEEEEAAAASSSSEEEE SSSSWWWWIIIITTTTCCCCHHHH TTTTOOOO UUUUSSSSIIIINNNNGGGG TTTTHHHHEEEE FFFFlllleeeexxxxLLLLMMMM LLLLIIIICCCCEEEENNNNSSSSIIIINNNNGGGG MMMMAAAANNNNAAAAGGGGEEEERRRR....
  17.  
  18.  
  19.  
  20.  
  21.  
  22. HHHHEEEEAAAADDDDEEEERRRR FFFFIIIILLLLEEEE
  23.      #include <Vk/VkNLS.h>
  24.  
  25. PPPPUUUUBBBBLLLLIIIICCCC PPPPRRRROOOOTTTTOOOOCCCCOOOOLLLL SSSSUUUUMMMMMMMMAAAARRRRYYYY
  26.    CCCCoooonnnnssssttttrrrruuuuccccttttoooorrrr////DDDDeeeessssttttrrrruuuuccccttttoooorrrr
  27.            VkNLS(char* vendorID,
  28.                  long key,
  29.                  int productID,
  30.                  char* version,
  31.                  NLSCallback loseLicenseCallback = NULL,
  32.                  void *clientData=NULL);
  33.  
  34.            void ~VkNLS(void);
  35.  
  36.  
  37. XXXX RRRREEEESSSSOOOOUUUURRRRCCCCEEEESSSS AAAASSSSSSSSOOOOCCCCIIIIAAAATTTTEEEEDDDD WWWWIIIITTTTHHHH TTTTHHHHIIIISSSS CCCCLLLLAAAASSSSSSSS
  38.            disableLicenseWarnings
  39.            disableThirtyDayLicenseWarnings
  40.            thirtyDayMessage
  41.            sixtyDayMessage
  42.            ninetyDayMessage
  43.            notEnoughLicensesMessage
  44.            noLicenseMessage
  45.            licenseExpiredMessage
  46.            warnLoseLicenseMessage
  47.            regainLicenseMessage
  48.  
  49.  
  50. CCCCLLLLAAAASSSSSSSS DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  51.           VkNLS provides a high-level interface to the NetLS network licensing
  52.           manager. The VkNLS class implements a policy based on the NetLS
  53.           license mechanism that simplifies the process of license protecting
  54.           applications. Applications merely instantiate an VkNLS object in
  55.           their application, providing some basic information about the
  56.           application and its licensing. The VkNLS object handles all license
  57.           verification, informing the user if there is a problem, and shutting
  58.           the application down if a license cannot be found.
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. VVVVkkkkNNNNLLLLSSSS((((3333xxxx))))                                                            VVVVkkkkNNNNLLLLSSSS((((3333xxxx))))
  71.  
  72.  
  73.  
  74.           VkNLS will look for either a node-locked or concurrent (networked)
  75.           license. There is no difference to the application for these
  76.           different types of licenses. Once the VKNLS object is instantiated,
  77.           the object immediately checks for a valid license. If no license is
  78.           found, the object posts a fatal error dialog, which the user must
  79.           dismiss, exiting the application.
  80.  
  81.           If a license is obtained, the license is rechecked every ten
  82.           minutes.  If the application's license is lost, a warning dialog is
  83.           posted warning that the license is no longer valid.  This dialog is
  84.           posted in blocking mode, so the user must dismiss it, however,the
  85.           application will not exit. Instead, the object begins checking every
  86.           minute for a license. If the license is restored, a dialog is posted
  87.           notifying the user, and the program returns to normal operation. If
  88.           the license is not found, another blocking dialog is posted every
  89.           minute.
  90.  
  91.           The VkNLS class also supports warnings for users whose licenses are
  92.           about to expire. By default, VkNLS will post a warning when a
  93.           license has less than 90 days before expiration.
  94.  
  95. RRRREEEESSSSOOOOUUUURRRRCCCCEEEESSSS
  96.      VkNLS recognizes several X resources that control the messages posted by
  97.      the various dialogs. These are:
  98.  
  99.    ddddiiiissssaaaabbbblllleeeeLLLLiiiicccceeeennnnsssseeeeWWWWaaaarrrrnnnniiiinnnnggggssss
  100.      If TRUE, don't show the warnings that appear when a license has only 90
  101.      days before expiration. The default is FALSE. This resource does not
  102.      disable messages when the license has less than 30 days before
  103.      expiration.
  104.  
  105.    ddddiiiissssaaaabbbblllleeeeTTTThhhhiiiirrrrttttyyyyDDDDaaaayyyyLLLLiiiicccceeeennnnsssseeeeWWWWaaaarrrrnnnniiiinnnnggggssss
  106.      If TRUE, don't show the warnings that appear when a license has only 30
  107.      days before expiration. The default is FALSE.
  108.  
  109.    tttthhhhiiiirrrrttttyyyyDDDDaaaayyyyMMMMeeeessssssssaaaaggggeeee
  110.      Determines the message to appear when only 30 days or less are left
  111.      before a license expires. The message is expected to embed a "%d"
  112.      printf-style integer spec in the message. VkNLS will plug the correct
  113.      number of days into this slot. For example:
  114.  
  115.           *thirtyDayMessage: Your license will expire in %d days
  116.  
  117.  
  118.    ssssiiiixxxxttttyyyyDDDDaaaayyyyMMMMeeeessssssssaaaaggggeeee
  119.      Determines the message to appear when between 60 and 30 days are left
  120.      before a license expires. The message is expected to embed a "%d"
  121.      printf-style integer spec in the message. VkNLS will plug the correct
  122.      number of days into this slot.
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. VVVVkkkkNNNNLLLLSSSS((((3333xxxx))))                                                            VVVVkkkkNNNNLLLLSSSS((((3333xxxx))))
  137.  
  138.  
  139.  
  140.    nnnniiiinnnneeeettttyyyyDDDDaaaayyyyMMMMeeeessssssssaaaaggggeeee
  141.      Determines the message to appear when between 90 and 60 days are left
  142.      before a license expires. The message is expected to embed a "%d"
  143.      printf-style integer spec in the message. VkNLS will plug the correct
  144.      number of days into this slot.
  145.  
  146.    nnnnoooottttEEEEnnnnoooouuuugggghhhhLLLLiiiicccceeeennnnsssseeeessssMMMMeeeessssssssaaaaggggeeee
  147.      Determines the message to appear when an application is licensed, but
  148.      there are not enough licenses currently available to support the number
  149.      of people using them.
  150.  
  151.    nnnnooooLLLLiiiicccceeeennnnsssseeeeMMMMeeeessssssssaaaaggggeeee
  152.      Determines the message to appear when no valid license can be found.
  153.  
  154.    lllliiiicccceeeennnnsssseeeeEEEExxxxppppiiiirrrreeeeddddMMMMeeeessssssssaaaaggggeeee
  155.      Determines the message to appear when an application has had a valid
  156.      license, but the license has now expired.
  157.  
  158.    wwwwaaaarrrrnnnnLLLLoooosssseeeeLLLLiiiicccceeeennnnsssseeeeMMMMeeeessssssssaaaaggggeeee
  159.      Determines the message to appear when an application has lost its license
  160.      while the application is running.
  161.  
  162.    rrrreeeeggggaaaaiiiinnnnLLLLiiiicccceeeennnnsssseeeeMMMMeeeessssssssaaaaggggeeee
  163.      Determines the message to appear when an application that has lots its
  164.      license has regained the license.
  165.  
  166. FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNNSSSS
  167.    VVVVkkkkNNNNLLLLSSSS(((())))
  168.            VkNLS(char* vendorID,
  169.                  long key,
  170.                  int productID,
  171.                  char* version,
  172.                  NLSCallback loseLicenseCallback = NULL,
  173.                  void *clientData=NULL);
  174.  
  175.  
  176.           _v_e_n_d_o_r_I_D is an encrypted string that uniquely identifies a vendor.
  177.           _k_e_y is an integral key.  _p_r_o_d_u_c_t_I_D is an integer value that uniquely
  178.           identifies a vendor's products.  You must obtain these values from
  179.           your NetLS administrator.
  180.  
  181.           _v_e_r_s_i_o_n specifies the version of the product.  It can be any string
  182.           that is meaningful to you.
  183.  
  184.           _l_o_s_e_L_i_c_e_n_s_e_C_a_l_l_b_a_c_k is an optional function pointer.  The VkNLS
  185.           object calls this function if it is unable to obtain a license.  If
  186.           you provide a _l_o_s_e_L_i_c_e_n_s_e_C_a_l_l_b_a_c_k function, VkNLS does not post the
  187.           fatal error dialog and exit the application.  It is up to the
  188.           application to do any needed error recovery, and to then exit if
  189.           appropriate.
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. VVVVkkkkNNNNLLLLSSSS((((3333xxxx))))                                                            VVVVkkkkNNNNLLLLSSSS((((3333xxxx))))
  203.  
  204.  
  205.  
  206.           NNNNooootttteeee:::: _l_o_s_e_L_i_c_e_n_s_e_C_a_l_l_b_a_c_k must be either a global function or as
  207.           static member function; it cannot be a regular member function.
  208.  
  209.    ~~~~VVVVkkkkNNNNLLLLSSSS(((())))
  210.           void ~VkNLS(void);
  211.  
  212.  
  213.           Free all storage associated with a VkNLS object and return any
  214.           license currently in use.
  215.  
  216. DDDDAAAATTTTAAAA MMMMEEEEMMMMBBBBEEEERRRR DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNNSSSS
  217. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  218.      _N_e_t_L_S _M_a_n_u_a_l , _V_i_e_w_K_i_t _P_r_o_g_r_a_m_m_e_r'_s _G_u_i_d_e
  219.  
  220.  
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.                                                                         PPPPaaaaggggeeee 4444
  262.  
  263.  
  264.  
  265.